Gửi tin nhắn theo cấu trúc khách hàng tự định nghĩa

(COMING SOON)

PiScale cung cấp API gửi tin nhắn theo cấu trúc tự định nghĩa.

HTTP request

POST https://{app_id}.api.piscale.com/chat-bot/v1.0/messages

Request body

Ví dụ

{
    "thread_id": "",
    "ext_user_ids": ["6872016393206779"],
    "user_ids": [],
    "body": {
        "text": "",
        "metadata": [
            {   
                "type": "custom_defined",
                "custom_name": "abczz", // xem trên dashboard
                "payload": "{}" // bạn tự định nghĩa trên dashboard
            }
        ]
    }
}

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
thread_id	string	Mã cuộc hội thoại	✗
ext_user_ids	array	Danh sách ext_user_id	✗
user_ids	array	Danh sách user_id	✗
body.text	string	Nội dung tin nhắn khi hiển thị ở định dạng văn bản	✓
body.metadata[0].type	string	Phải là custom_defined	✓
body.metadata[0].custom_name	string	Tên kiểu tin nhắn tùy biến	✓
body.metadata[0].payload	string	Dữ liệu tin nhắn theo định dạng JSON	✓

note

• Bắt buộc thread_id hoặc ext_user_ids hoặc user_ids phải có dữ liệu.
• Đích đến của tin nhắn sẽ được ưu tiên theo thứ tự thread_id, ext_user_ids, user_ids.
• ext_user_ids tối đa 1000 phần tử.
• user_ids tối đa 100 phần tử.
• Metadata chỉ có 1 phần tử

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ

{
    "message_code": "M200",
    "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp